<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>headset.peripherals.PositionController'</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="headset-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >HeaDSET</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="headset-module.html">Package&nbsp;headset</a> ::
        <a href="headset.peripherals-module.html">Package&nbsp;peripherals</a> ::
        Module&nbsp;PositionController'
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="headset.peripherals.PositionController%27-module.html">Module headset.peripherals.PositionController'</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-docstring">        The position controller enables the box widget for the instrument. This</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-docstring">        allows the user to position the instrument before doinig the operation and </tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-docstring">        can also be used to simulate an operation.</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"><tt class="py-docstring">        @author: J.H. Donker</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-docstring">        @</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line"> </tt>
<a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Class headset.peripherals.InputController'.InputController=headset.peripherals.InputController%27.InputController-class.html"><a title="headset.peripherals.InputController'.InputController" class="py-name" href="#" onclick="return doclink('link-0', 'InputController', 'link-0');">InputController</a></tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name"><a title="headset.peripherals.InputController'.InputController" class="py-name" href="#" onclick="return doclink('link-1', 'InputController', 'link-0');">InputController</a></tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-2" class="py-name" targets="Module headset.peripherals.InputInterface=headset.peripherals.InputInterface-module.html"><a title="headset.peripherals.InputInterface" class="py-name" href="#" onclick="return doclink('link-2', 'InputInterface', 'link-2');">InputInterface</a></tt> <tt class="py-keyword">import</tt> <tt id="link-3" class="py-name" targets="Class headset.peripherals.InputInterface.InputWrapper=headset.peripherals.InputInterface.InputWrapper-class.html"><a title="headset.peripherals.InputInterface.InputWrapper" class="py-name" href="#" onclick="return doclink('link-3', 'InputWrapper', 'link-3');">InputWrapper</a></tt> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"><tt class="py-comment">#gheto controller</tt> </tt>
<a name="PositionController"></a><div id="PositionController-def"><a name="L14"></a><tt class="py-lineno">14</tt> <a class="py-toggle" href="#" id="PositionController-toggle" onclick="return toggle('PositionController');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">class</tt> <a class="py-def-name" href="headset.peripherals.PositionController'.PositionController-class.html">PositionController</a><tt class="py-op">(</tt><tt class="py-base-class">InputController</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PositionController-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="PositionController-expanded"><a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line">        <tt class="py-docstring">'''</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-docstring">                Enables a boxwidget around the instrument. Knows more about the system</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line"><tt class="py-docstring">                than usual.</tt> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"><tt class="py-docstring">                </tt> </tt>
<a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line"><tt class="py-docstring">                @param inputInterface: A interface of version 1.1.</tt> </tt>
<a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="PositionController.__init__"></a><div id="PositionController.__init__-def"><a name="L21"></a><tt class="py-lineno">21</tt> <a class="py-toggle" href="#" id="PositionController.__init__-toggle" onclick="return toggle('PositionController.__init__');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="headset.peripherals.PositionController'.PositionController-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">inputInterface</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PositionController.__init__-collapsed" style="display:none;" pad="++" indent="++++++++++++"></div><div id="PositionController.__init__-expanded"><a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line">                <tt id="link-4" class="py-name"><a title="headset.peripherals.InputController'.InputController" class="py-name" href="#" onclick="return doclink('link-4', 'InputController', 'link-0');">InputController</a></tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method headset.Main.StartFrame.__init__()=headset.Main.StartFrame-class.html#__init__,Method headset.examples.InputExamples.Forwarder.__init__()=headset.examples.InputExamples.Forwarder-class.html#__init__,Method headset.examples.InputExamples.SimpleJoystickController.__init__()=headset.examples.InputExamples.SimpleJoystickController-class.html#__init__,Method headset.examples.OutputExamples.AdvancedLogger.__init__()=headset.examples.OutputExamples.AdvancedLogger-class.html#__init__,Method headset.examples.OutputExamples.SimpleLogger.__init__()=headset.examples.OutputExamples.SimpleLogger-class.html#__init__,Method headset.gui.ConfigureViewports'.ConfigureViewports.__init__()=headset.gui.ConfigureViewports%27.ConfigureViewports-class.html#__init__,Method headset.gui.FloatSpinner'.FloatSpinner.__init__()=headset.gui.FloatSpinner%27.FloatSpinner-class.html#__init__,Method headset.gui.Help.HelpWindow.__init__()=headset.gui.Help.HelpWindow-class.html#__init__,Method headset.gui.MainController.CommonController.__init__()=headset.gui.MainController.CommonController-class.html#__init__,Method headset.gui.MainController.Controller.__init__()=headset.gui.MainController.Controller-class.html#__init__,Method headset.gui.MainController.DicomDialog.__init__()=headset.gui.MainController.DicomDialog-class.html#__init__,Method headset.gui.MainController.ModelingController.__init__()=headset.gui.MainController.ModelingController-class.html#__init__,Method headset.gui.MainController.OperationController.__init__()=headset.gui.MainController.OperationController-class.html#__init__,Method headset.gui.MainController.PlayerController.__init__()=headset.gui.MainController.PlayerController-class.html#__init__,Method headset.gui.MainController.PropertiesDialog.__init__()=headset.gui.MainController.PropertiesDialog-class.html#__init__,Method headset.gui.MainView.ModelingView.__init__()=headset.gui.MainView.ModelingView-class.html#__init__,Method headset.gui.MainView.MyStatusBar.__init__()=headset.gui.MainView.MyStatusBar-class.html#__init__,Method headset.gui.MainView.OperationView.__init__()=headset.gui.MainView.OperationView-class.html#__init__,Method headset.gui.MainView.PlayerView.__init__()=headset.gui.MainView.PlayerView-class.html#__init__,Method headset.gui.MainView.View.__init__()=headset.gui.MainView.View-class.html#__init__,Method headset.gui.VTKComponent'.VTKComponent.__init__()=headset.gui.VTKComponent%27.VTKComponent-class.html#__init__,Method headset.gui.VTKInteractor'.EventTimer.__init__()=headset.gui.VTKInteractor%27.EventTimer-class.html#__init__,Method headset.gui.VTKView'.VTKView.__init__()=headset.gui.VTKView%27.VTKView-class.html#__init__,Method headset.model.HeaDSETCone'.HeaDSETCone.__init__()=headset.model.HeaDSETCone%27.HeaDSETCone-class.html#__init__,Method headset.model.HeaDSETCube'.HeaDSETCube.__init__()=headset.model.HeaDSETCube%27.HeaDSETCube-class.html#__init__,Method headset.model.HeaDSETCylinder'.HeaDSETCylinder.__init__()=headset.model.HeaDSETCylinder%27.HeaDSETCylinder-class.html#__init__,Method headset.model.HeaDSETDicom'.HeaDSETDicom.__init__()=headset.model.HeaDSETDicom%27.HeaDSETDicom-class.html#__init__,Method headset.model.HeaDSETGeom'.HeaDSETGeom.__init__()=headset.model.HeaDSETGeom%27.HeaDSETGeom-class.html#__init__,Method headset.model.HeaDSETSphere'.HeaDSETSphere.__init__()=headset.model.HeaDSETSphere%27.HeaDSETSphere-class.html#__init__,Method headset.model.Model.HeaDSETModel.__init__()=headset.model.Model.HeaDSETModel-class.html#__init__,Method headset.model.RecordingBase.Recording.__init__()=headset.model.RecordingBase.Recording-class.html#__init__,Method headset.model.RecordingBase.RecordingAtom.__init__()=headset.model.RecordingBase.RecordingAtom-class.html#__init__,Method headset.peripherals.InputController'.InputController.__init__()=headset.peripherals.InputController%27.InputController-class.html#__init__,Method headset.peripherals.InputController'.PolledInputController.__init__()=headset.peripherals.InputController%27.PolledInputController-class.html#__init__,Method headset.peripherals.InputController'.TimedInputController.__init__()=headset.peripherals.InputController%27.TimedInputController-class.html#__init__,Method headset.peripherals.InputInterface.InputWrapper.__init__()=headset.peripherals.InputInterface.InputWrapper-class.html#__init__,Method headset.peripherals.InputInterface.WrapperInterface.__init__()=headset.peripherals.InputInterface.WrapperInterface-class.html#__init__,Method headset.peripherals.JoystickController'.JoystickController.__init__()=headset.peripherals.JoystickController%27.JoystickController-class.html#__init__,Method headset.peripherals.OutputController'.OutputController.__init__()=headset.peripherals.OutputController%27.OutputController-class.html#__init__,Method headset.peripherals.OutputInstrumentRecording'.OutputInstrumentRecording.__init__()=headset.peripherals.OutputInstrumentRecording%27.OutputInstrumentRecording-class.html#__init__,Method headset.peripherals.OutputJournal'.OutputJournal.__init__()=headset.peripherals.OutputJournal%27.OutputJournal-class.html#__init__,Method headset.peripherals.PlaybackController.PlayBackController.__init__()=headset.peripherals.PlaybackController.PlayBackController-class.html#__init__,Method headset.peripherals.PositionController'.PositionController.__init__()=headset.peripherals.PositionController%27.PositionController-class.html#__init__,Method headset.util.Saver.ArchiveSaver.__init__()=headset.util.Saver.ArchiveSaver-class.html#__init__,Method headset.util.Snake'.Snake.__init__()=headset.util.Snake%27.Snake-class.html#__init__"><a title="headset.Main.StartFrame.__init__
headset.examples.InputExamples.Forwarder.__init__
headset.examples.InputExamples.SimpleJoystickController.__init__
headset.examples.OutputExamples.AdvancedLogger.__init__
headset.examples.OutputExamples.SimpleLogger.__init__
headset.gui.ConfigureViewports'.ConfigureViewports.__init__
headset.gui.FloatSpinner'.FloatSpinner.__init__
headset.gui.Help.HelpWindow.__init__
headset.gui.MainController.CommonController.__init__
headset.gui.MainController.Controller.__init__
headset.gui.MainController.DicomDialog.__init__
headset.gui.MainController.ModelingController.__init__
headset.gui.MainController.OperationController.__init__
headset.gui.MainController.PlayerController.__init__
headset.gui.MainController.PropertiesDialog.__init__
headset.gui.MainView.ModelingView.__init__
headset.gui.MainView.MyStatusBar.__init__
headset.gui.MainView.OperationView.__init__
headset.gui.MainView.PlayerView.__init__
headset.gui.MainView.View.__init__
headset.gui.VTKComponent'.VTKComponent.__init__
headset.gui.VTKInteractor'.EventTimer.__init__
headset.gui.VTKView'.VTKView.__init__
headset.model.HeaDSETCone'.HeaDSETCone.__init__
headset.model.HeaDSETCube'.HeaDSETCube.__init__
headset.model.HeaDSETCylinder'.HeaDSETCylinder.__init__
headset.model.HeaDSETDicom'.HeaDSETDicom.__init__
headset.model.HeaDSETGeom'.HeaDSETGeom.__init__
headset.model.HeaDSETSphere'.HeaDSETSphere.__init__
headset.model.Model.HeaDSETModel.__init__
headset.model.RecordingBase.Recording.__init__
headset.model.RecordingBase.RecordingAtom.__init__
headset.peripherals.InputController'.InputController.__init__
headset.peripherals.InputController'.PolledInputController.__init__
headset.peripherals.InputController'.TimedInputController.__init__
headset.peripherals.InputInterface.InputWrapper.__init__
headset.peripherals.InputInterface.WrapperInterface.__init__
headset.peripherals.JoystickController'.JoystickController.__init__
headset.peripherals.OutputController'.OutputController.__init__
headset.peripherals.OutputInstrumentRecording'.OutputInstrumentRecording.__init__
headset.peripherals.OutputJournal'.OutputJournal.__init__
headset.peripherals.PlaybackController.PlayBackController.__init__
headset.peripherals.PositionController'.PositionController.__init__
headset.util.Saver.ArchiveSaver.__init__
headset.util.Snake'.Snake.__init__" class="py-name" href="#" onclick="return doclink('link-5', '__init__', 'link-5');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">inputInterface</tt><tt class="py-op">)</tt> </tt>
</div><a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line">                 </tt>
<a name="PositionController.Start"></a><div id="PositionController.Start-def"><a name="L24"></a><tt class="py-lineno">24</tt> <a class="py-toggle" href="#" id="PositionController.Start-toggle" onclick="return toggle('PositionController.Start');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="headset.peripherals.PositionController'.PositionController-class.html#Start">Start</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PositionController.Start-collapsed" style="display:none;" pad="++" indent="++++++++++++"></div><div id="PositionController.Start-expanded"><a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line">                <tt class="py-docstring">'''</tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line"><tt class="py-docstring">                        Start the boxwidget around the instrument.</tt> </tt>
<a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line"><tt class="py-docstring">                '''</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_inputInterface</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Method headset.peripherals.InputInterface.InputWrapper.BoxWidgetInstrument()=headset.peripherals.InputInterface.InputWrapper-class.html#BoxWidgetInstrument"><a title="headset.peripherals.InputInterface.InputWrapper.BoxWidgetInstrument" class="py-name" href="#" onclick="return doclink('link-6', 'BoxWidgetInstrument', 'link-6');">BoxWidgetInstrument</a></tt><tt class="py-op">(</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
</div><a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line">         </tt>
<a name="PositionController.Stop"></a><div id="PositionController.Stop-def"><a name="L30"></a><tt class="py-lineno">30</tt> <a class="py-toggle" href="#" id="PositionController.Stop-toggle" onclick="return toggle('PositionController.Stop');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="headset.peripherals.PositionController'.PositionController-class.html#Stop">Stop</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PositionController.Stop-collapsed" style="display:none;" pad="++" indent="++++++++++++"></div><div id="PositionController.Stop-expanded"><a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line">                <tt class="py-docstring">'''</tt> </tt>
<a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line"><tt class="py-docstring">                        Stops the boxwidget around the instrument.</tt> </tt>
<a name="L33"></a><tt class="py-lineno">33</tt>  <tt class="py-line"><tt class="py-docstring">                '''</tt> </tt>
<a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_inputInterface</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="headset.peripherals.InputInterface.InputWrapper.BoxWidgetInstrument" class="py-name" href="#" onclick="return doclink('link-7', 'BoxWidgetInstrument', 'link-6');">BoxWidgetInstrument</a></tt><tt class="py-op">(</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L35"></a><tt class="py-lineno">35</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="headset-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >HeaDSET</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    <a href="epydoc-log.html">Generated by Epydoc
    3.0.1 on Wed Feb 25 12:58:03 2009</a>
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
